chore: improve mixed models#1645
Merged
Merged
Conversation
zepfred
force-pushed
the
chore/mixed-improvement
branch
from
ee00fb3 to
c047e45
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the support for mixed models by enabling nearby features and updating the configuration, heuristic, and move selector components accordingly while re-enabling mixed model tests. Key changes include:
- New documentation describing mixed modeling and construction heuristics.
- Re-enabling and adjusting tests for mixed model scenarios.
- Updating phase, heuristic, and move selector configuration to support mixed models (including nearby setting adjustments).
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/optimization-algorithms/construction-heuristics.adoc | Adds documentation for mixed modeling and construction heuristics. |
| core/src/test/java/ai/timefold/solver/core/impl/solver/DefaultSolverTest.java | Re-enables and updates mixed model test cases. |
| core/src/test/java/ai/timefold/solver/core/impl/heuristic/selector/move/generic/list/SubListSwapMoveSelectorFactoryTest.java core/src/test/java/ai/timefold/solver/core/impl/heuristic/selector/move/generic/list/SubListChangeMoveSelectorFactoryTest.java core/src/test/java/ai/timefold/solver/core/impl/constructionheuristic/DefaultConstructionHeuristicPhaseTest.java |
Removes previously disabled mixed model tests. |
| core/src/main/java/ai/timefold/solver/core/impl/phase/PhaseFactory.java | Adds logic to disable nearby settings for mixed models and updates config policy accordingly. |
| core/src/main/java/ai/timefold/solver/core/impl/heuristic/selector/list/SubListSelectorFactory.java | Ensures a variable name is set for mixed models when none is provided. |
| core/src/main/java/ai/timefold/solver/core/impl/heuristic/HeuristicConfigPolicy.java | Adds a method to copy config policy without nearby settings. |
| Core configuration files for move selector configs (KOpt, ListSwap, ListChange, TailChainSwap, Swap, Change, Union) and NearbyAutoConfigurationEnabled.java | Updates implementations of canEnableNearbyInMixedModels according to mixed model requirements. |
Comments suppressed due to low confidence (3)
core/src/main/java/ai/timefold/solver/core/impl/heuristic/selector/list/SubListSelectorFactory.java:119
- [nitpick] When automatically setting the variable name for mixed models, consider adding a validation or clarifying comment to ensure the correct list variable is selected if multiple exist.
if (configPolicy.getSolutionDescriptor().hasBothBasicAndListVariables() && valueSelectorConfig.getVariableName() == null) {
core/src/main/java/ai/timefold/solver/core/impl/phase/PhaseFactory.java:71
- [nitpick] Consider adding a brief inline comment explaining why disabling the nearby setting is necessary for mixed models to improve future maintainability.
var disableNearbySetting = configPolicy.getNearbyDistanceMeterClass() != null && entityPlacerConfig != null && QueuedEntityPlacerConfig.class.isAssignableFrom(entityPlacerConfig.getClass()) && configPolicy.getSolutionDescriptor().hasBothBasicAndListVariables();
core/src/test/java/ai/timefold/solver/core/impl/solver/DefaultSolverTest.java:1657
- With the re-enabling of mixed model tests, verify that sufficient tests exist for both success and failure scenarios to ensure stable behavior in edge cases.
void failMixedModel() {
GitHub Actions
Failure
zepfred
force-pushed
the
chore/mixed-improvement
branch
from
7759cfa to
7df5be8
Compare
Contributor
Author
The coverage is achieved through the new tests on the enterprise repository, and duplication does not seem important. |
triceo
approved these changes
Jun 16, 2025
triceo
left a comment
triceo
left a comment
Collaborator
There was a problem hiding this comment.
LGTM when comments resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR includes improvements necessary for configuring the nearby features. All related tests were added to the enterprise repo.